/*
 * Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.pkl.core;

import java.nio.file.Path;
import java.util.Collection;
import java.util.List;
import java.util.regex.Pattern;
import org.pkl.core.util.Nullable;

/**
 * Parent interface to builder classes for configuring a {@link SecurityManager}.
 *
 * @param <B> concrete type of the builder class to maintain covariance in inherited methods
 */
public interface SecurityManagerBuilder<B extends SecurityManagerBuilder<B>> {
  B addAllowedModule(Pattern pattern);

  B addAllowedModules(Collection<Pattern> patterns);

  B setAllowedModules(Collection<Pattern> patterns);

  List<Pattern> getAllowedModules();

  B addAllowedResource(Pattern pattern);

  B addAllowedResources(Collection<Pattern> patterns);

  B setAllowedResources(Collection<Pattern> patterns);

  List<Pattern> getAllowedResources();

  B setRootDir(@Nullable Path rootDir);

  @Nullable
  Path getRootDir();

  SecurityManager build();
}
